<div class="main-content">

        <h2>APIDetailed</h2>
            <table class="table table-hover">
                <colgroup>
                    <col style="width: 10%;"/>
                    <col style="width: 30%;"/>
                    <col style="width: 10%;"/>
                    <col style="width: 20%;"/>
                    <col style="width: 30%;"/>
                </colgroup>
                <thead>
                <tr>
                    <th>Name</th>
                    <th>Description</th>
                    <th>Schema</th>
                    <th>Default</th>
                    <th>Example</th>
                </tr>
                </thead>
                <tbody>
                    <tr>
                        <td class="parameter">
                            <p>id</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">UUID of the api registry artifact </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">01234567-0123-0123-0123-012345678901</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>name</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Name of the API</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">CalculatorAPI</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>description</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">A brief description about the API</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">A calculator API that supports basic operations</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>context</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">A string that represents the context of the user&#39;s request</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">CalculatorAPI</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>version</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The version of the API</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">1.0.0</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>provider</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">If the provider value is not given, the user invoking the API will be used as the provider. </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">admin</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>status</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">This describes in which status of the lifecycle the API is</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">CREATED</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>thumbnailUri</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">/apis/01234567-0123-0123-0123-012345678901/thumbnail</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>apiDefinition</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Swagger definition of the API which contains details about URI templates and scopes </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">{&quot;paths&quot;:{&quot;/substract&quot;:{&quot;get&quot;:{&quot;x-auth-type&quot;:&quot;Application &amp; Application User&quot;,&quot;x-throttling-tier&quot;:&quot;Unlimited&quot;,&quot;parameters&quot;:[{&quot;name&quot;:&quot;x&quot;,&quot;required&quot;:true,&quot;type&quot;:&quot;string&quot;,&quot;in&quot;:&quot;query&quot;},{&quot;name&quot;:&quot;y&quot;,&quot;required&quot;:true,&quot;type&quot;:&quot;string&quot;,&quot;in&quot;:&quot;query&quot;}],&quot;responses&quot;:{&quot;200&quot;:{}}}},&quot;/add&quot;:{&quot;get&quot;:{&quot;x-auth-type&quot;:&quot;Application &amp; Application User&quot;,&quot;x-throttling-tier&quot;:&quot;Unlimited&quot;,&quot;parameters&quot;:[{&quot;name&quot;:&quot;x&quot;,&quot;required&quot;:true,&quot;type&quot;:&quot;string&quot;,&quot;in&quot;:&quot;query&quot;},{&quot;name&quot;:&quot;y&quot;,&quot;required&quot;:true,&quot;type&quot;:&quot;string&quot;,&quot;in&quot;:&quot;query&quot;}],&quot;responses&quot;:{&quot;200&quot;:{}}}}},&quot;swagger&quot;:&quot;2.0&quot;,&quot;info&quot;:{&quot;title&quot;:&quot;CalculatorAPI&quot;,&quot;version&quot;:&quot;1.0.0&quot;}}</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>wsdlUri</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">WSDL URL if the API is based on a WSDL endpoint </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">http://www.webservicex.com/globalweather.asmx?wsdl</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>responseCaching</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">Disabled</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>cacheTimeout</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#integer">integer</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">300</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>destinationStatsEnabled</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">Disabled</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>isDefaultVersion</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#boolean">boolean</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">false</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>type</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The api creation type to be used. Accepted values are HTTP, WS, SOAPTOREST</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">HTTP</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>transport</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Supported transports for the API (http and/or https). </p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[&quot;http&quot;,&quot;https&quot;]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>tags</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Search keywords related to the API</p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[&quot;substract&quot;,&quot;add&quot;]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>tiers</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The subscription tiers selected for the particular API</p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[&quot;Unlimited&quot;]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>apiLevelPolicy</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The policy selected for the particular API</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">Unlimited</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>authorizationHeader</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used. </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>apiSecurity</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Type of API security, the current API secured with. It can be either OAuth2 or mutual SSL or both. If it is not set OAuth2 will be set as the security for the current API. </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>maxTps</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#APIMaxTps">APIMaxTps</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>visibility</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The visibility level of the API. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED OR CONTROLLED.</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">PUBLIC</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>visibleRoles</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The user roles that are able to access the API</p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>visibleTenants</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>endpointConfig</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">{&quot;production_endpoints&quot;:{&quot;url&quot;:&quot;https://localhost:9443/am/sample/pizzashack/v1/api/&quot;,&quot;config&quot;:{&quot;suspendErrorCode&quot;:&quot;101000&quot;,&quot;suspendDuration&quot;:&quot;2000&quot;,&quot;suspendMaxDuration&quot;:&quot;3&quot;,&quot;factor&quot;:&quot;2&quot;,&quot;retryErroCode&quot;:&quot;101000&quot;,&quot;retryTimeOut&quot;:&quot;4&quot;,&quot;retryDelay&quot;:&quot;1000&quot;,&quot;actionSelect&quot;:&quot;fault&quot;,&quot;actionDuration&quot;:&quot;3000&quot;}},&quot;sandbox_endpoints&quot;:{&quot;url&quot;:&quot;https://localhost:9443/am/sample/pizzashack/v1/api/&quot;,&quot;config&quot;:null},&quot;endpoint_type&quot;:&quot;http&quot;}</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>endpointSecurity</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#APIEndpointSecurity">APIEndpointSecurity</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>gatewayEnvironments</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Comma separated list of gateway environments. </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">Default</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>labels</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Labels of micro-gateway environments attached to the API. </p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>sequences</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">&quot;\&quot;sequences\&quot;: [ {\&quot;name\&quot;: \&quot;json_to_xml_in_message\&quot;,\&quot;config\&quot;: null,\&quot;type\&quot;: \&quot;in\&quot;}, {\&quot;name\&quot;: \&quot;xml_to_json_out_message\&quot;,\&quot;config\&quot;: null,\&quot;type\&quot;: \&quot;out\&quot;}, {\&quot;name\&quot;: \&quot;json_fault\&quot;,\&quot;config\&quot;: null,\&quot;type\&quot;: \&quot;fault\&quot;} ],&quot;</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>subscriptionAvailability</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The subscription availability. Accepts one of the following. current_tenant, all_tenants or specific_tenants.</p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">current_tenant</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>subscriptionAvailableTenants</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[&quot;tenant1&quot;,&quot;tenant2&quot;]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>additionalProperties</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Map of custom properties of API</p></td>
                        <td class="parameter">
                                <a href="#!/models#map">map</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>accessControl</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">Is the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators. If the accessControl restriction is none, this API can be modified by all the publishers and creators, if not it can only be viewable/modifiable by certain set of publishers and creators,  based on the restriction. </p></td>
                        <td class="parameter">
                                <a href="#!/models#string">string</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>accessControlRoles</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked">The user roles that are able to view/modify as API publisher or creator.</p></td>
                        <td class="parameter">
                                <a href="#!/models#array">array</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked">[&quot;admin&quot;]</p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>businessInformation</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#APIBusinessInformation">APIBusinessInformation</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                    <tr>
                        <td class="parameter">
                            <p>corsConfiguration</p>
                            <p class="param-required">
                                
                                optional
                            </p>
                        </td>
                        <td class="parameter"><p class="marked"></p></td>
                        <td class="parameter">
                                <a href="#!/models#APICorsConfiguration">APICorsConfiguration</a>
                        </td>
                        <td class="parameter"> <p class="marked">null</p></td>
                        <td class="parameter"> <p class="marked"></p></td>
                    </tr>
                </tbody>
            </table>
</div>
